/*
 * To change this template, choose Tools | Templates
 * and open the template in the editor.
 */
package net.sourceforge.openclixml.domcomparator;


/**
 * This Enummeration defines the possible return types for the dom comparator.
 * @author dominikjungo
 */
public enum ReturnTypes {
    /** Both DOM Objects are the same. */
    same(0),
    /** Both DOM Objects are different. No detailed reason why is given. */
    different(-1),
    /** Both DOM Objects are different, because the namespaces are different. */
    differentNamespace(-2),
    /** Both DOM Objects are different, because the number of attributes are different. */
    differentNumbersOfAttributes(-3),
    /** Both DOM Objects are different, because the attribute is different. */
    differentAttribute(-4),
    /** Both DOM Objects are different, because a child is different. */
    differentChild(-5),
    /** Both DOM Lists are different, because they have different lenght.  */
    differentNodeListLength(-6),
    /** Both DOM Nodes are different. No detailed reason why is given.*/
    differentNode(-7),
    /** Both DOM Elements are different because the name of the element is different. */
    differentElementName(-8);
    /** The return code. */
    private int code;

    /** Creates a new return type. */
    ReturnTypes(final int codeP) {
        this.code = codeP;
    }

    /** Gets the Code for a return type.
     * @return the code of the return type
     */
    public int getCode() {
        return code;
    }
}
